<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: fsm_slave_scan.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('fsm__slave__scan_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">fsm_slave_scan.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>EtherCAT slave scanning state machine.  
<a href="#details">More...</a></p>

<p><a href="fsm__slave__scan_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structec__fsm__slave__scan.html">ec_fsm_slave_scan</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finite state machine for scanning an EtherCAT slave.  <a href="structec__fsm__slave__scan.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:af779dfb24a2c28e995f2080786b5f56f"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structec__fsm__slave__scan.html">ec_fsm_slave_scan</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__slave__scan_8h.html#af779dfb24a2c28e995f2080786b5f56f">ec_fsm_slave_scan_t</a></td></tr>
<tr class="separator:af779dfb24a2c28e995f2080786b5f56f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a7912e997b054006bbaead33b64ef4dda"><td class="memItemLeft" align="right" valign="top"><a id="a7912e997b054006bbaead33b64ef4dda"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__slave__scan_8h.html#a7912e997b054006bbaead33b64ef4dda">ec_fsm_slave_scan_init</a> (<a class="el" href="fsm__slave__scan_8h.html#af779dfb24a2c28e995f2080786b5f56f">ec_fsm_slave_scan_t</a> *, <a class="el" href="structec__datagram__t.html">ec_datagram_t</a> *, <a class="el" href="fsm__slave__config_8h.html#a31e1e414b22a05b9dd1302d6ed036c0b">ec_fsm_slave_config_t</a> *, <a class="el" href="fsm__pdo_8h.html#ac13e2c6bdf50dbba47d2165f173322cd">ec_fsm_pdo_t</a> *)</td></tr>
<tr class="memdesc:a7912e997b054006bbaead33b64ef4dda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a7912e997b054006bbaead33b64ef4dda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6d93f28242bb84c1e3310b54183bfd5"><td class="memItemLeft" align="right" valign="top"><a id="ad6d93f28242bb84c1e3310b54183bfd5"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__slave__scan_8h.html#ad6d93f28242bb84c1e3310b54183bfd5">ec_fsm_slave_scan_clear</a> (<a class="el" href="fsm__slave__scan_8h.html#af779dfb24a2c28e995f2080786b5f56f">ec_fsm_slave_scan_t</a> *)</td></tr>
<tr class="memdesc:ad6d93f28242bb84c1e3310b54183bfd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:ad6d93f28242bb84c1e3310b54183bfd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aecd8f803a19c3d4cbe77e0a25a84c388"><td class="memItemLeft" align="right" valign="top"><a id="aecd8f803a19c3d4cbe77e0a25a84c388"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__slave__scan_8h.html#aecd8f803a19c3d4cbe77e0a25a84c388">ec_fsm_slave_scan_start</a> (<a class="el" href="fsm__slave__scan_8h.html#af779dfb24a2c28e995f2080786b5f56f">ec_fsm_slave_scan_t</a> *, <a class="el" href="globals_8h.html#a8d9ffff7dbe1babaa4786a63f2860d57">ec_slave_t</a> *)</td></tr>
<tr class="memdesc:aecd8f803a19c3d4cbe77e0a25a84c388"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start slave scan state machine. <br /></td></tr>
<tr class="separator:aecd8f803a19c3d4cbe77e0a25a84c388"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1d834da98e531e644bbc86b224df697"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__slave__scan_8h.html#af1d834da98e531e644bbc86b224df697">ec_fsm_slave_scan_exec</a> (<a class="el" href="fsm__slave__scan_8h.html#af779dfb24a2c28e995f2080786b5f56f">ec_fsm_slave_scan_t</a> *)</td></tr>
<tr class="memdesc:af1d834da98e531e644bbc86b224df697"><td class="mdescLeft">&#160;</td><td class="mdescRight">Executes the current state of the state machine.  <a href="#af1d834da98e531e644bbc86b224df697">More...</a><br /></td></tr>
<tr class="separator:af1d834da98e531e644bbc86b224df697"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a4806351b9f9497139c248360804408"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__slave__scan_8h.html#a9a4806351b9f9497139c248360804408">ec_fsm_slave_scan_success</a> (const <a class="el" href="fsm__slave__scan_8h.html#af779dfb24a2c28e995f2080786b5f56f">ec_fsm_slave_scan_t</a> *)</td></tr>
<tr class="separator:a9a4806351b9f9497139c248360804408"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>EtherCAT slave scanning state machine. </p>

<p class="definition">Definition in file <a class="el" href="fsm__slave__scan_8h_source.html">fsm_slave_scan.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="af779dfb24a2c28e995f2080786b5f56f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af779dfb24a2c28e995f2080786b5f56f">&#9670;&nbsp;</a></span>ec_fsm_slave_scan_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structec__fsm__slave__scan.html">ec_fsm_slave_scan</a> <a class="el" href="fsm__slave__scan_8h.html#af779dfb24a2c28e995f2080786b5f56f">ec_fsm_slave_scan_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structec__fsm__slave__scan.html" title="Finite state machine for scanning an EtherCAT slave. ">ec_fsm_slave_scan</a> </dd></dl>

<p class="definition">Definition at line <a class="el" href="fsm__slave__scan_8h_source.html#l00051">51</a> of file <a class="el" href="fsm__slave__scan_8h_source.html">fsm_slave_scan.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="af1d834da98e531e644bbc86b224df697"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1d834da98e531e644bbc86b224df697">&#9670;&nbsp;</a></span>ec_fsm_slave_scan_exec()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_fsm_slave_scan_exec </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="fsm__slave__scan_8h.html#af779dfb24a2c28e995f2080786b5f56f">ec_fsm_slave_scan_t</a> *&#160;</td>
          <td class="paramname"><em>fsm</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Executes the current state of the state machine. </p>
<p>If the state machine's datagram is not sent or received yet, the execution of the state machine is delayed to the next cycle. </p><dl class="section return"><dt>Returns</dt><dd>false, if state machine has terminated </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fsm</td><td>slave state machine </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="fsm__slave__scan_8c_source.html#l00141">141</a> of file <a class="el" href="fsm__slave__scan_8c_source.html">fsm_slave_scan.c</a>.</p>

</div>
</div>
<a id="a9a4806351b9f9497139c248360804408"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a4806351b9f9497139c248360804408">&#9670;&nbsp;</a></span>ec_fsm_slave_scan_success()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_fsm_slave_scan_success </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="fsm__slave__scan_8h.html#af779dfb24a2c28e995f2080786b5f56f">ec_fsm_slave_scan_t</a> *&#160;</td>
          <td class="paramname"><em>fsm</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true, if the state machine terminated gracefully </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fsm</td><td>slave state machine </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="fsm__slave__scan_8c_source.html#l00159">159</a> of file <a class="el" href="fsm__slave__scan_8c_source.html">fsm_slave_scan.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="fsm__slave__scan_8h.html">fsm_slave_scan.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
